home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / bit / help / filter.hlp < prev    next >
Text File  |  1994-08-01  |  2KB  |  39 lines
  1.  
  2. @C1@c@b@_ External Filters
  3.  
  4.      Pipe the current image thru an external filter and replace the current
  5.      image with the filtered one.
  6.  
  7. @b  Definitions
  8.      A filter is defined as an external program that reads at least one
  9.      of the BIT supported formats from argv[1] and output the (possibly)
  10.      transformed image to stdout. All external filter definitions must 
  11.      start with the at (@) sign and any line that does not is silently
  12.      ignored.
  13.  
  14.      A filter definition should have the following format
  15. @f    @title; name; options; in1;[in2;[in3;]]
  16.      where title is the text to use to label the activation button and name
  17.      and options are the command and option to use in the popen(3S)
  18.      system call; in{[1-3]} is the accepted formats for the program. 
  19.      If the option field contains a single question mark "?", a string 
  20.      will be prompted before the external program is run. If title is empty,
  21.      the program name is used to label the button.  The following is a valid
  22.      filter definition
  23.  
  24. @f   @rotate45 ; pnmrotate; 45 ; ppm; pgm; pbm;
  25.  
  26.      Also See /usr/local/lib/bit/BIT_filters for some examples
  27.  
  28. @b File Locations
  29.      The external filter definition should be in a file named BIT_filters. 
  30.      The program will search the system directory, /usr/local/lib/bit,
  31.      current directory, and ~/.bitrc/ (or environment variable BITDIR)
  32.      in that order for BIT_filters. 
  33.  
  34. @b Special Note
  35.      The input format should be in order of decreasing generality,
  36.      i.e., ppm; pgm; pbm. 
  37.  
  38.  
  39.